Skip to content

Fix typos found by codespell#21

Closed
DimitriPapadopoulos wants to merge 1 commit into
NSIS-Dev:masterfrom
DimitriPapadopoulos:codespell
Closed

Fix typos found by codespell#21
DimitriPapadopoulos wants to merge 1 commit into
NSIS-Dev:masterfrom
DimitriPapadopoulos:codespell

Conversation

@DimitriPapadopoulos
Copy link
Copy Markdown

Some typos are in user-visible strings and documentation, others are in code comments.

In the long term, I recommend fixing all typos, including those in code comments, because tools like codespell do not make a difference between code comments and documentation and user-visible strings.

I have left out typos in Contrib, they should be fixed upstream.

@DimitriPapadopoulos
Copy link
Copy Markdown
Author

DimitriPapadopoulos commented Dec 30, 2021

Not sure about _miscrosoft_docs_are_wrong_microsoft_docs_are_wrong.

I believe it's OK because it's a private variable.

@sredna
Copy link
Copy Markdown
Member

sredna commented Dec 30, 2021

I have left out typos in Contrib, they should be fixed upstream

We own most of Contrib. If there is anything upstream I'll deal with it.

@DimitriPapadopoulos
Copy link
Copy Markdown
Author

Fixed typos in Contrib too.

Comment thread Include/Win/RestartManager.nsh Outdated
@DimitriPapadopoulos
Copy link
Copy Markdown
Author

DimitriPapadopoulos commented Dec 31, 2021

I have left out Language files by the way.

There may be a few starting comments in English to fix, for example appropiateappropriate:
https://github.com/kichik/nsis/blob/268379229b0c1ef00603779890a28d0345ab0240/Contrib/Language%20files/Romanian.nsh#L8

Should I fix these comments?

Edit: That's actually the only typo in there; I have fixed it.

@DimitriPapadopoulos
Copy link
Copy Markdown
Author

DimitriPapadopoulos commented Dec 31, 2021

And I just noticed part of the initial fixes, under Docs/src/halibut, must actually be fixed upstream.

Edit: I've sent a mail to the upstream maintainer.
Edit: Ongoing discussion with the upstream maintainer: are both bulletted and bulleted (as in the Oxford dictionary) correct in UK English?

@sredna
Copy link
Copy Markdown
Member

sredna commented Dec 31, 2021

are both bulletted and bulleted (as in the Oxford dictionary) correct in UK English?

Bulletted only has 35k hits on Google vs millions for Bulleted. I'll take the fix.

@sredna sredna self-requested a review January 4, 2022 01:20
@DimitriPapadopoulos
Copy link
Copy Markdown
Author

I see you have merged this change into the Subversion trunk. Thanks! Would it be worth adding a configuration file .codespellrc to silence false positives and simplify future maintenance?

@sredna
Copy link
Copy Markdown
Member

sredna commented Jan 10, 2022

I suppose that depends on how many false-positives you had to deal with and what the maintenance overhead is...

@DimitriPapadopoulos
Copy link
Copy Markdown
Author

I am afraid nsis has many false positives:

$ codespell | wc -l
954
$ 

Most of them are in translation files that should be skipped. A .codespellrc file could drastically reduce that number by skipping these files. For example:

$ codespell --skip 'Language files' | wc -l
226
$ 

The can further reduce that number by ignoring some words:

$ codespell --skip 'Language files' --ignore-words-list parms | wc -l
133
$ 

The benefit of a .codespllrc is that developers get consistent results when running codespell locally.

Fix last typos in the process.

About "everytime" see for example:
https://www.grammarly.com/blog/everytime-every-time/
@DimitriPapadopoulos
Copy link
Copy Markdown
Author

All fixes have been merged, thank you. I have added a .codespellrc file and fixed the last typos. Do you think it's worth merging?

@Neustradamus
Copy link
Copy Markdown

@DimitriPapadopoulos: There is one file to remove from the PR, I think.

@sredna, @kichik, @idleberg: What do you think?

@DimitriPapadopoulos
Copy link
Copy Markdown
Author

Which file should I remove?

@Neustradamus
Copy link
Copy Markdown

@DimitriPapadopoulos: .codespellrc

@DimitriPapadopoulos
Copy link
Copy Markdown
Author

Why?

@Neustradamus
Copy link
Copy Markdown

@DimitriPapadopoulos: Because it is not need in this project.

Why have you closed?

@DimitriPapadopoulos
Copy link
Copy Markdown
Author

Why is it not needed in this project?

I closed this PR because I am unable to update it. Following up in #33.

@Neustradamus
Copy link
Copy Markdown

The file is from your configuration...

@DimitriPapadopoulos
Copy link
Copy Markdown
Author

Not at all, I was suggesting it's added to the configuration of this project. See above.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants